RFC - definition of a runner class using as much of the existing code as possible by syntron · Pull Request #404 · OpenModelica/OMPython

syntron · 2026-01-11T18:12:51Z

Content (lots of changes / these will be splitted into several PRs if the general approach is approved):

OMCSession.py: rename real OMCPath* classes as privat (start with '_')
OMCSession: define OMCPathDummy and OMCSessionDummy => no OMC server
ModelExecution.py: include all code related to model execution (from OMCsession*; ModelicaSystemCmd)
ModelicaSystemDoE.py: seperate file for this class
ModelicaSystemDoE.py: use ModelicaSystem / reduce number of arguments to init
ModelicaSystem(Base).py: split getOutputs() and getContinuous() to Initial and Final data
ModelicaSystem(Base).py: getOutputs*() / getContinuous*() - always return np.float64
ModelicaSystemBase.py: define a basic version of ModelicaSystem
ModelicaSystemRunner.py: definition of a 'runner' class using ModelicaSystemBasic / OMCSessionDummy (see PR Enable the usage of a pre-built model executables by ModelicaSystemRunner #401)
test_ModelicaSystemRunner.py: test case for ModelicaSystemRunner
test_*: update of test cases based on above listed changes

Compared to PR #401 this solution:

still uses the existing OMPython requirements (dependencies of the Runner class; i.e. numpy, etc.)
shares nearly all code with the current definitions (by using OMCPathDummy and OMCSessionDummy)
uses | instead of Union

Further changes could do additional modifications such that the 3rd party packages (ZMQ) are not needed at all in the runner code path.

All tests are running without error / tested in https://github.com/syntron/OMPython/actions/runs/20865402893

Please comment!

syntron · 2026-02-09T22:23:44Z

Some status update on this PR - the main points are:

Define a runner functionality which allows to run compiled (binary) models without OMC (see PR Enable the usage of a pre-built model executables by ModelicaSystemRunner #401 / @joewa)
Allow compatibility with OMPython 4.0.0 by defining a support layer on top of the latest code (see [OMCSession*] renames #384 (comment); @casella)

The code defined here updates the internal structure of OMPython such that:

generic code is separated in ABC classes
derived code exists for OMC usage and Runner usage
a compatibility layer exists such that the interface of OMPython 4.0.0 is (basically) supported; this is tested using the original unittests from v4.0.0

Furthermore, as OMCPath is working only for Python >= 3.12, another dimension exists. There is a dummy implementation of OMCPath for Python < 3.12 such that most of the functionality can also be used here. See PR #401 for a hint that even older Python version are used (Python 3.10 or even lower).

These changes could be the baseline for a new documentation (see https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/ompython.html). My idea was to include these changes as 4.x.0 and create a cut at the next release (or keep some kind of compatibility layer alive).

(partly from the discussion in PR #387)

syntron · 2026-02-09T22:26:46Z

The failed test is due to Windows - it runs well for v4.0.0 (see: https://github.com/syntron/OMPython/actions/runs/21842400755) and 4.x.x (see: https://github.com/syntron/OMPython/actions/runs/21841418638)

syntron · 2026-02-13T23:15:37Z

This is a final version of my changes to get a 'runner' functionality to OMPython. The main parts:

Compatibility with OMPython v4.0.0
Split fucntions into ABC / OMC / Runner
Split the large files into smaller onces based on the usage

This PR will be splitted into smaller steps.

arun3688

looks good

syntron · 2026-02-16T21:06:08Z

looks good

OK; I will create small parts for review & merge; there are some changes on top to restructure the two main files

adeas31 · 2026-02-18T15:46:55Z

looks good

OK; I will create small parts for review & merge; there are some changes on top to restructure the two main files

Sorry I haven't got time to look into this yet.
As I understand, you will break this into new smaller PRs for review & merge, right?

syntron · 2026-02-18T17:57:53Z

Sorry I haven't got time to look into this yet. As I understand, you will break this into new smaller PRs for review & merge, right?

yes - this is the plan; the one RFC is way too big / too much changes to get an easy overview ...

syntron · 2026-02-18T17:59:39Z

Summary of the changes in these RFC; the elements will be provided as single PRs.

Basic concept / plan:

Define a Runner variant which allows to run compiled (binary) models without usage of an OMC server
Split all code into 3 parts: ABC (generic code), OMC related, Runner related
Define a compatibility layer which provides OMPython v4.0.0 compatibility

This means for some period of time, the new interface and the compatibility layer can exist in parallel (versions
4.x.x). Thus, errors can be found & fixed and people can adapt to the new interface before it is the only option.

Steps for the implementation (see PRs below):

(A) independent PRs based on current master; together these build the baseline for (B) and further
(B) split classes into ABC / OMC related
(C) define Runner part
(D) use unittests from v4.0.0 as reference / prepare compatibility layer
(E) prepare & split files (move classes around)
(F) cleanup after changes
(G) move all depreciated code into the compatibility layer
(H) removal of compatibility layer for a OMPython v5.0.0 (merged later)

I tried to order the PRs based on the steps (A) to (H) but some will be out of order. If the PRs are merged, please try
to follow the numbering.

PRs based on this RFC (using the branch name in my fork syntron:OMPython as reference; I will use this comment to link the PRs step by step):

(step A)

(A001) simplify_workflow_Test
(A002) OMParser
(A003) OMTypedParser
(A004) ModelicaSystem_okey_oval
(A005) OMCPath_remove_stat
(A006) OMCSession_small_fixes
(A007) ModelicaSystem_cleanup
(A008) ModelicaSystem_getContinuous_getOutputs
(A009) ModelicaSystem_small_fixes
(A000) use_function_keyword_arguments
(A011) update_init_docstring
(A012) reorder_imports
(A013) ModelicaSystemDoE
(A014) ModelExecution
(A015) ModelicaSystem_check_model_executable

(step B)

(B001) ModelicaSystem_split
(B002) ModelicaSystemDoE_split
(B003) OMCSession_OMPathABC
(B004) OMCSession_OMSessionABC

(step C)

(C001) Runner_definitions

(step D)

(D001) OMSession_small_fixes
(D002) OMSessionZMQ_move
(D003) OMCPath_improve
(D004) OMSessionRunner
(D005) OMCSession_classes_update
(D006) ModelicaSystem_small_fixes2
(D007) test_v400
(D008) v400_compatibility_layer

(step E)

(E001) update_tests
(E002) prepare_restructure
(E003) restructure

(step F)

(F001) restructure_cleanup

=> status syntron_RFC

step G & H are still to be reordered

syntron · 2026-02-18T18:42:05Z

PRs of step A:

(A001) simplify_workflow_Test - PR #411 - UPDATED
(A002) OMParser - PR #412
DONE - (A003) OMTypedParser - PR #413
DONE - (A004) ModelicaSystem_okey_oval - PR #414
(A005) OMCPath_remove_stat - PR #415
(A006) OMCSession_small_fixes - PR #416
(A007) ModelicaSystem_cleanup - PR #417
(A008) ModelicaSystem_getContinuous_getOutputs - PR #418
(A009) ModelicaSystem_small_fixes - PR #419
(A011) update_init_docstring - PR #421
(A012) reorder_imports - PR #422
(A013) ModelicaSystemDoE - PR #423

moved to the end / rebase needed:
(A010) use_function_keyword_arguments - PR #420
(A014) ModelExecution - PR #424
(A015) ModelicaSystem_check_model_executable - PR #425 (on top of PR #424)

The final state can be found at https://github.com/syntron/OMPython/tree/mergeA

* use .items()

…ivate variable _model_name

* ModelicaSystemRunner & OMCPath * ModelicaSystemRunner & OMPathRunnerLocal * ModelicaSystemRunner & OMPathRunnerBash * ModelicaSystemRunner & OMPathRunnerBash using docker * ModelicaSystemRunner & OMPathRunnerBash using WSL (not tested!)

* OMCPath & OMCSessionZMQ * OMCPath & OMCSessionLocal * OMCPath & OMCSessionDocker * OMCPath & OMCSessionWSL (not tested!) * OMPathLocal & OMCSessionRunner * OMPathBash & OMCSessionRunner * OMPathBash & OMCSessionRunner in docker * OMPathBash & OMCSessionRunner in WSL (not tested!)

reason: * it is only a test for OMC / not OMPython specific * furthermore, it is run automatically via cron job (= FMITest)

syntron · 2026-02-26T20:10:35Z

@joewa any feedback from your side?

@Sonyoyo could you test the runner functionality for WSL? I do not have this option available to me ...

adeas31 · 2026-02-26T21:10:00Z

@adeas31 I'm working with smaller commits which build up the PR in serveral steps; however, if these are merged into one commit, were is a high risk for merge conflicts for later PRs especially if these build on top of each other. Would it be OK if I create single step PRs for section B to E (see #404 (comment))? I would keep the details locally but only push one-commit PRs ...

Yeah sounds good.

syntron mentioned this pull request Jan 11, 2026

Enable the usage of a pre-built model executables by ModelicaSystemRunner #401

Open

joewa mentioned this pull request Jan 11, 2026

Syntron rfc joewa/OMPython#1

Merged

syntron force-pushed the syntron_RFC branch 5 times, most recently from 6ef0900 to 0deda10 Compare February 9, 2026 22:13

syntron mentioned this pull request Feb 9, 2026

Remove OMCSessionZMQ #387

Draft

syntron force-pushed the syntron_RFC branch from 0deda10 to dd7df9e Compare February 13, 2026 23:15

syntron marked this pull request as ready for review February 13, 2026 23:20

syntron force-pushed the syntron_RFC branch 2 times, most recently from be89d52 to b20568b Compare February 15, 2026 11:17

adeas31 requested review from adeas31 and arun3688 February 16, 2026 16:30

arun3688 approved these changes Feb 16, 2026

View reviewed changes

syntron force-pushed the syntron_RFC branch from b20568b to 4568c87 Compare February 17, 2026 20:32

syntron marked this pull request as draft February 18, 2026 18:16

This was referenced Feb 18, 2026

(A001) Simplify workflow for unittests #411

Merged

(A002) OMParser #412

Merged

(A003) [OMTypedParser] fix PyparsingDeprecationWarning(s) + reorder imports #413

Merged

(A004) [ModelicaSystemCmd] do not reuse variable names (key/val) #414

Merged

syntron mentioned this pull request Feb 18, 2026

(A005) [OMCPathReal] remove dummy function stat() #415

Merged

syntron added 27 commits February 26, 2026 20:40

[test_*] reorder imports

98b7ca4

[tests_ModelicaDoE*] fix pylint hint

5e19fad

* use .items()

[tests_*] use OMSessionABC.get_version()

081d599

[test_ModelicaSystemCmd] use get_model_name() instead of access to pr…

857129a

…ivate variable _model_name

[test_ModelicaSystemOMC] read file using utf-8 encoding / linter fix

80d0293

[test_ModelicaSystemRunner] update test case

95de02e

* ModelicaSystemRunner & OMCPath * ModelicaSystemRunner & OMPathRunnerLocal * ModelicaSystemRunner & OMPathRunnerBash * ModelicaSystemRunner & OMPathRunnerBash using docker * ModelicaSystemRunner & OMPathRunnerBash using WSL (not tested!)

add workflow to run unittests in ./tests

c75e531

[test_OMParser] use only the public interface => om_parser_basic()

6392928

[test_OMTypedParser] rename file / use om_parser_typed()

db25dd0

update tests - do NOT run test_FMIRegression.py

ae32f9c

reason: * it is only a test for OMC / not OMPython specific * furthermore, it is run automatically via cron job (= FMITest)

[test_ModelExecutionCmd] rename from test_ModelicaSystemCmd

e6aa2c8

[ModelicaSystemCmd] add missing docstring

bf4e357

[OMCSession] spelling fixes

a816ad9

[OMCSessionCmd] add warning about depreciated class

9fc6497

[OMCSessionABC] remove duplicated code; see OMSessionABC

75190de

[OMSessionRunnerABC] define class

c40816b

[OMCSessionZMQ] call super()__init__()

c3ce012

[OMCPath] fix forward dependency on OMCSessionLocal

2d9bc88

[OMSessionException] rename from OMCSessionException

b899323

[__init__] fix imports

a7131bb

[ModelExecution*] move classes into model_execution.py

175969a

[OMCSession] split file

e9c06d1

[ModelicaSystem] split file

121acd6

[README.md] small updates

fc1bc76

[__init__] small updates

6801e7d

Merge branch 'test_v400' into syntron_RFC

6e36e0d

syntron force-pushed the syntron_RFC branch from 4568c87 to 6e36e0d Compare February 26, 2026 19:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RFC - definition of a runner class using as much of the existing code as possible#404

RFC - definition of a runner class using as much of the existing code as possible#404
syntron wants to merge 102 commits intoOpenModelica:masterfrom
syntron:syntron_RFC

syntron commented Jan 11, 2026

Uh oh!

syntron commented Feb 9, 2026

Uh oh!

syntron commented Feb 9, 2026

Uh oh!

syntron commented Feb 13, 2026

Uh oh!

arun3688 left a comment

Uh oh!

syntron commented Feb 16, 2026

Uh oh!

adeas31 commented Feb 18, 2026

Uh oh!

syntron commented Feb 18, 2026

Uh oh!

syntron commented Feb 18, 2026 •

edited

Loading

Uh oh!

syntron commented Feb 18, 2026 •

edited

Loading

Uh oh!

syntron commented Feb 26, 2026

Uh oh!

adeas31 commented Feb 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

syntron commented Jan 11, 2026

Uh oh!

syntron commented Feb 9, 2026

Uh oh!

syntron commented Feb 9, 2026

Uh oh!

syntron commented Feb 13, 2026

Uh oh!

arun3688 left a comment

Choose a reason for hiding this comment

Uh oh!

syntron commented Feb 16, 2026

Uh oh!

adeas31 commented Feb 18, 2026

Uh oh!

syntron commented Feb 18, 2026

Uh oh!

syntron commented Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

syntron commented Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

syntron commented Feb 26, 2026

Uh oh!

adeas31 commented Feb 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

syntron commented Feb 18, 2026 •

edited

Loading

syntron commented Feb 18, 2026 •

edited

Loading